<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>trngpsv: xtrngpsv.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">trngpsv
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xtrngpsv_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xtrngpsv.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gae698f09de78d4a85f18ceb4584290998"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gae698f09de78d4a85f18ceb4584290998">XTRNGPSV_BURST_SIZE</a>&#160;&#160;&#160;16U</td></tr>
<tr class="memdesc:gae698f09de78d4a85f18ceb4584290998"><td class="mdescLeft">&#160;</td><td class="mdescRight">QCNT of 4 * 4 bytes (reg width)= 16 bytes.  <a href="group___overview.html#gae698f09de78d4a85f18ceb4584290998">More...</a><br/></td></tr>
<tr class="separator:gae698f09de78d4a85f18ceb4584290998"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad5311926d609af993f9d8d38353fc198"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gad5311926d609af993f9d8d38353fc198">XTRNGPSV_NUM_INIT_REGS</a>&#160;&#160;&#160;12U</td></tr>
<tr class="memdesc:gad5311926d609af993f9d8d38353fc198"><td class="mdescLeft">&#160;</td><td class="mdescRight">No.  <a href="group___overview.html#gad5311926d609af993f9d8d38353fc198">More...</a><br/></td></tr>
<tr class="separator:gad5311926d609af993f9d8d38353fc198"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga33ffb78c8affb44dce84e9992b98f5bf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga33ffb78c8affb44dce84e9992b98f5bf">XTRNGPSV_BYTES_PER_REG</a>&#160;&#160;&#160;4U</td></tr>
<tr class="memdesc:ga33ffb78c8affb44dce84e9992b98f5bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bytes register (i.e.  <a href="group___overview.html#ga33ffb78c8affb44dce84e9992b98f5bf">More...</a><br/></td></tr>
<tr class="separator:ga33ffb78c8affb44dce84e9992b98f5bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga71c506122d996ee33872997923bf27c8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga71c506122d996ee33872997923bf27c8">XTRNGPSV_ENTROPY_SEED_LEN_BYTES</a>&#160;&#160;&#160;64U</td></tr>
<tr class="memdesc:ga71c506122d996ee33872997923bf27c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Entropy SEED length in terms of security strength.  <a href="group___overview.html#ga71c506122d996ee33872997923bf27c8">More...</a><br/></td></tr>
<tr class="separator:ga71c506122d996ee33872997923bf27c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga384cd70c07b942e5ff526389092d1d5c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga384cd70c07b942e5ff526389092d1d5c">XTRNGPSV_SEC_STRENGTH_SHIFT</a>&#160;&#160;&#160;5U</td></tr>
<tr class="memdesc:ga384cd70c07b942e5ff526389092d1d5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shift value in terms of security strength.  <a href="group___overview.html#ga384cd70c07b942e5ff526389092d1d5c">More...</a><br/></td></tr>
<tr class="separator:ga384cd70c07b942e5ff526389092d1d5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1adfaf24d66bdaa44b32782aa60dd52b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga1adfaf24d66bdaa44b32782aa60dd52b">XTRNGPSV_MAX_QCNT_MASK</a>&#160;&#160;&#160;0x800U</td></tr>
<tr class="memdesc:ga1adfaf24d66bdaa44b32782aa60dd52b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask value for maximum QCNT (i.e 4U &lt;&lt; 9U)  <a href="group___overview.html#ga1adfaf24d66bdaa44b32782aa60dd52b">More...</a><br/></td></tr>
<tr class="separator:ga1adfaf24d66bdaa44b32782aa60dd52b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2cc784a2d2b3207f518ea452784acfa4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga2cc784a2d2b3207f518ea452784acfa4">XTRNGPSV_WORD_ALIGN_MASK</a>&#160;&#160;&#160;0x03U</td></tr>
<tr class="memdesc:ga2cc784a2d2b3207f518ea452784acfa4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask to check whether the address is word aligned.  <a href="group___overview.html#ga2cc784a2d2b3207f518ea452784acfa4">More...</a><br/></td></tr>
<tr class="separator:ga2cc784a2d2b3207f518ea452784acfa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga08661f569f5eaed8ccfce4bbe77418ee"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga08661f569f5eaed8ccfce4bbe77418ee">XTRNGPSV_RESEED_TIMEOUT</a>&#160;&#160;&#160;15000U</td></tr>
<tr class="memdesc:ga08661f569f5eaed8ccfce4bbe77418ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reseed timeout in micro-seconds.  <a href="group___overview.html#ga08661f569f5eaed8ccfce4bbe77418ee">More...</a><br/></td></tr>
<tr class="separator:ga08661f569f5eaed8ccfce4bbe77418ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab045c4eb49985e55ba704c592926638e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gab045c4eb49985e55ba704c592926638e">XTRNGPSV_GENERATE_TIMEOUT</a>&#160;&#160;&#160;8000U</td></tr>
<tr class="memdesc:gab045c4eb49985e55ba704c592926638e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate timeout in micro-seconds.  <a href="group___overview.html#gab045c4eb49985e55ba704c592926638e">More...</a><br/></td></tr>
<tr class="separator:gab045c4eb49985e55ba704c592926638e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae0a32b098c1e6a19ba4d6eff3199efbc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gae0a32b098c1e6a19ba4d6eff3199efbc">PRNGMODE_RESEED</a>&#160;&#160;&#160;0U</td></tr>
<tr class="memdesc:gae0a32b098c1e6a19ba4d6eff3199efbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">PRNG in Reseed mode.  <a href="group___overview.html#gae0a32b098c1e6a19ba4d6eff3199efbc">More...</a><br/></td></tr>
<tr class="separator:gae0a32b098c1e6a19ba4d6eff3199efbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga274db95f3fe3c0983d1106216113dd94"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga274db95f3fe3c0983d1106216113dd94">PRNGMODE_GEN</a>&#160;&#160;&#160;<a class="el" href="group___overview.html#ga3d4799e72c1f1e4380a42fb3697a0aae">TRNG_CTRL_PRNGMODE_MASK</a></td></tr>
<tr class="memdesc:ga274db95f3fe3c0983d1106216113dd94"><td class="mdescLeft">&#160;</td><td class="mdescRight">PRNG in Generate mode.  <a href="group___overview.html#ga274db95f3fe3c0983d1106216113dd94">More...</a><br/></td></tr>
<tr class="separator:ga274db95f3fe3c0983d1106216113dd94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3245cf5a97edbe50c506de8b0400c8be"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga3245cf5a97edbe50c506de8b0400c8be">XTRNGPSV_MIN_SEEDLIFE</a>&#160;&#160;&#160;1U</td></tr>
<tr class="memdesc:ga3245cf5a97edbe50c506de8b0400c8be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum seed life.  <a href="group___overview.html#ga3245cf5a97edbe50c506de8b0400c8be">More...</a><br/></td></tr>
<tr class="separator:ga3245cf5a97edbe50c506de8b0400c8be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab7362c7d0aed7d4750953ee42bcefda8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gab7362c7d0aed7d4750953ee42bcefda8">XTRNGPSV_MAX_SEEDLIFE</a>&#160;&#160;&#160;0x1000000000000U</td></tr>
<tr class="memdesc:gab7362c7d0aed7d4750953ee42bcefda8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum seed life 2^^48.  <a href="group___overview.html#gab7362c7d0aed7d4750953ee42bcefda8">More...</a><br/></td></tr>
<tr class="separator:gab7362c7d0aed7d4750953ee42bcefda8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9f01da93d2fc7e4528320c2c17d87874"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga9f01da93d2fc7e4528320c2c17d87874">XTRNGPSV_MIN_DFLENMUL</a>&#160;&#160;&#160;2U</td></tr>
<tr class="memdesc:ga9f01da93d2fc7e4528320c2c17d87874"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum DF Length Multiplier.This assumes additional multiplier of 1 for nonce.  <a href="group___overview.html#ga9f01da93d2fc7e4528320c2c17d87874">More...</a><br/></td></tr>
<tr class="separator:ga9f01da93d2fc7e4528320c2c17d87874"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b6fa99d5fa0f5e63f0547fb7cbee39e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga2b6fa99d5fa0f5e63f0547fb7cbee39e">XTRNGPSV_MAX_DFLENMUL</a>&#160;&#160;&#160;9U</td></tr>
<tr class="memdesc:ga2b6fa99d5fa0f5e63f0547fb7cbee39e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum DF Length Multiplier.  <a href="group___overview.html#ga2b6fa99d5fa0f5e63f0547fb7cbee39e">More...</a><br/></td></tr>
<tr class="separator:ga2b6fa99d5fa0f5e63f0547fb7cbee39e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabcff3c9fd87d8dac4818e0c42c120b64"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gabcff3c9fd87d8dac4818e0c42c120b64">ALL_A_PATTERN_32</a>&#160;&#160;&#160;0xAAAAAAAAU</td></tr>
<tr class="memdesc:gabcff3c9fd87d8dac4818e0c42c120b64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pattern of 10101010...  <a href="group___overview.html#gabcff3c9fd87d8dac4818e0c42c120b64">More...</a><br/></td></tr>
<tr class="separator:gabcff3c9fd87d8dac4818e0c42c120b64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4ac1d5096bf49deb553bffae78afa9b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gae4ac1d5096bf49deb553bffae78afa9b">ALL_5_PATTERN_32</a>&#160;&#160;&#160;0x55555555U</td></tr>
<tr class="memdesc:gae4ac1d5096bf49deb553bffae78afa9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pattern of 01010101...  <a href="group___overview.html#gae4ac1d5096bf49deb553bffae78afa9b">More...</a><br/></td></tr>
<tr class="separator:gae4ac1d5096bf49deb553bffae78afa9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f1226244e161294423fac73a93d034d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga5f1226244e161294423fac73a93d034d">RESET_DELAY</a>&#160;&#160;&#160;10U</td></tr>
<tr class="memdesc:ga5f1226244e161294423fac73a93d034d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delay used in Reset operations.  <a href="group___overview.html#ga5f1226244e161294423fac73a93d034d">More...</a><br/></td></tr>
<tr class="separator:ga5f1226244e161294423fac73a93d034d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga7b6a82053b11bedbd37a2a82dd0ba14d"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga7b6a82053b11bedbd37a2a82dd0ba14d">XTrngpsv_Instantiate</a> (XTrngpsv *InstancePtr, const XTrngpsv_UsrCfg *ConfigurValues)</td></tr>
<tr class="memdesc:ga7b6a82053b11bedbd37a2a82dd0ba14d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function further initializes i.e.  <a href="group___overview.html#ga7b6a82053b11bedbd37a2a82dd0ba14d">More...</a><br/></td></tr>
<tr class="separator:ga7b6a82053b11bedbd37a2a82dd0ba14d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7740e9622a48052d5ebb9ddf10165138"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga7740e9622a48052d5ebb9ddf10165138">XTrngpsv_Reseed</a> (XTrngpsv *InstancePtr, const u8 *ExtSeedPtr, u32 DFLenMul)</td></tr>
<tr class="memdesc:ga7740e9622a48052d5ebb9ddf10165138"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reseeds the TRNG in DRNG, HRNG modes.  <a href="group___overview.html#ga7740e9622a48052d5ebb9ddf10165138">More...</a><br/></td></tr>
<tr class="separator:ga7740e9622a48052d5ebb9ddf10165138"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d5b1c7182c8de3767e0345a3435ffe5"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga2d5b1c7182c8de3767e0345a3435ffe5">XTrngpsv_Generate</a> (XTrngpsv *InstancePtr, u8 *RandBufPtr, u32 RandBufSize, u8 PredResistanceEn)</td></tr>
<tr class="memdesc:ga2d5b1c7182c8de3767e0345a3435ffe5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This the function which actually generates and provides random bits to the caller.  <a href="group___overview.html#ga2d5b1c7182c8de3767e0345a3435ffe5">More...</a><br/></td></tr>
<tr class="separator:ga2d5b1c7182c8de3767e0345a3435ffe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad0c8b58adb37a766661ca12aa302ed53"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gad0c8b58adb37a766661ca12aa302ed53">XTrngpsv_Uninstantiate</a> (XTrngpsv *InstancePtr)</td></tr>
<tr class="memdesc:gad0c8b58adb37a766661ca12aa302ed53"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to put the TRNG in reset state, and clear the instance data including configuration, status.  <a href="group___overview.html#gad0c8b58adb37a766661ca12aa302ed53">More...</a><br/></td></tr>
<tr class="separator:gad0c8b58adb37a766661ca12aa302ed53"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
